FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server 3.4.11  |  FHIR Version n/a  User: [n/a]

Resource CapabilityStatement/FHIR Server from package hl7.fhir.us.directory-attestation#current (140 ms)

Package hl7.fhir.us.directory-attestation
Type CapabilityStatement
Id Id
FHIR Version R4
Source http://hl7.org/fhir/us/directory-attestation/https://build.fhir.org/ig/HL7/fhir-directory-attestation/CapabilityStatement-NatlDir.html
Url http://hl7.org/fhir/us/directory-attestation/CapabilityStatement/NatlDir
Version 1.0.0-ballot
Status active
Date 2020-11-19
Name DavinciPdexNatlDirCapabilityStatement
Title NatlDir CapabilityStatement
Experimental False
Realm us
Authority hl7
Description This Section describes the expected capabilities of the NatlDir Server actor which is responsible for providing responses to the queries submitted by the NatlDir Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by NatlDir Servers are defined. Systems implementing this capability statement should meet the CMS FInal Rule requirement for provider directory access. NatlDir Clients can use the required capabilities to access necessary data based on their local use cases and other contextual requirements.
Kind requirements

Resources that use this resource

No resources found

Resources that this resource uses

SearchParameter
endpoint-organization NatlDir_sp_endpoint_organization
healthcareservice-coverage-area NatlDir_sp_healthcareservice_coverage_area
healthcareservice-endpoint NatlDir_sp_healthcareservice_endpoint
healthcareservice-location NatlDir_sp_healthcareservice_location
healthcareservice-name NatlDir_sp_healthcareservice_name
healthcareservice-organization NatlDir_sp_healthcareservice_organization
healthcareservice-service-category NatlDir_sp_healthcareservice_category
healthcareservice-service-type NatlDir_sp_healthcareservice_type
healthcareservice-specialty NatlDir_sp_healthcareservice_specialty
insuranceplan-administered-by NatlDir_sp_insuranceplan_administered_by
insuranceplan-coverage-area NatlDir_sp_insuranceplan_coverage_area
insuranceplan-identifier NatlDir_sp_insuranceplan_identifier
insuranceplan-name NatlDir_sp_insuranceplan_name
insuranceplan-owned-by NatlDir_sp_insuranceplan_owned_by
insuranceplan-plan-type NatlDir_sp_insuranceplan_plan_type
insuranceplan-type NatlDir_sp_insuranceplan_type
location-address-city NatlDir_sp_location_address_city
location-address-postalcode NatlDir_sp_location_address_postalcode
location-address-state NatlDir_sp_location_address_state
location-address NatlDir_sp_location_address
location-endpoint NatlDir_sp_location_endpoint
location-organization NatlDir_sp_location_organization
location-partof NatlDir_sp_location_partof
location-type NatlDir_sp_location_type
organization-address NatlDir_sp_organization_address
organization-coverage-area NatlDir_sp_network_coverage_area
organization-endpoint NatlDir_sp_organization_endpoint
organization-name NatlDir_sp_organization_name
organization-partof NatlDir_sp_organization_partof
organization-type NatlDir_sp_organization_type
organizationaffiliation-endpoint NatlDir_sp_organizationaffiliation_endpoint
organizationaffiliation-location NatlDir_sp_organizationaffiliation_location
organizationaffiliation-network NatlDir_sp_organizationaffiliation_network
organizationaffiliation-participating-organization NatlDir_sp_organizationaffiliation_participating_organization
organizationaffiliation-primary-organization NatlDir_sp_organizationaffiliation_primary_organization
organizationaffiliation-role NatlDir_sp_organizationaffiliation_role
organizationaffiliation-service NatlDir_sp_organizationaffiliation_service
organizationaffiliation-specialty NatlDir_sp_organizationaffiliation_specialty
practitioner-family-name NatlDir_sp_practitioner_family_name
practitioner-given-name NatlDir_sp_practitioner_given_name
practitioner-name NatlDir_sp_practitioner_name
practitionerrole-endpoint NatlDir_sp_practitionerrole_endpoint
practitionerrole-location NatlDir_sp_practitionerrole_location
practitionerrole-network NatlDir_sp_practitionerrole_network
practitionerrole-organization NatlDir_sp_practitionerrole_organization
practitionerrole-practitioner NatlDir_sp_practitionerrole_practitioner
practitionerrole-role NatlDir_sp_practitionerrole_role
practitionerrole-service NatlDir_sp_practitionerrole_service
practitionerrole-specialty NatlDir_sp_practitionerrole_specialty
http://hl7.org/fhir/us/directory-attestation/StructureDefinition/NatlDirAttest-Endpoint NatDir Endpoint
http://hl7.org/fhir/us/directory-attestation/StructureDefinition/NatlDirAttest-HealthcareService National Directory HealthcareService
http://hl7.org/fhir/us/directory-attestation/StructureDefinition/NatlDirAttest-InsurancePlan NatDir InsurancePlan
http://hl7.org/fhir/us/directory-attestation/StructureDefinition/NatlDirAttest-Location NatDir Location
http://hl7.org/fhir/us/directory-attestation/StructureDefinition/NatlDirAttest-Network NatDir Network
http://hl7.org/fhir/us/directory-attestation/StructureDefinition/NatlDirAttest-Organization NatDir Organization
http://hl7.org/fhir/us/directory-attestation/StructureDefinition/NatlDirAttest-OrganizationAffiliation NatDir OrganizationAffiliation
http://hl7.org/fhir/us/directory-attestation/StructureDefinition/NatlDirAttest-Practitioner NatDir Practitioner
http://hl7.org/fhir/us/directory-attestation/StructureDefinition/NatlDirAttest-PractitionerRole NatDir PractitionerRole

Narrative

Note: links and images are rebased to the (stated) source

NatlDir CapabilityStatement

  • Implementation Guide Version: 1.0.0
  • FHIR Version: 4.0.1
  • Supported formats: xml, json
  • Published: 2020-11-19
  • Published by: HL7 Financial Management Working Group (FM WG)

This Section describes the expected capabilities of the NatlDir Server actor which is responsible for providing responses to the queries submitted by the NatlDir Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by NatlDir Servers are defined. Systems implementing this capability statement should meet the CMS FInal Rule requirement for provider directory access. NatlDir Clients can use the required capabilities to access necessary data based on their local use cases and other contextual requirements.

FHIR RESTful Capabilities

The NatlDir Server SHALL:

  1. Support all profiles defined in this Implementation Guide..
  2. Implement the RESTful behavior according to the FHIR specification.
  3. Return the following response classes:
    • (Status 400): invalid parameter
    • (Status 401/4xx): unauthorized request
    • (Status 403): insufficient scope
    • (Status 404): unknown resource
    • (Status 410): deleted resource.
  4. Support json source formats for all NatlDir interactions.
  5. Identify the NatlDir profiles supported as part of the FHIR meta.profile attribute for each instance.
  6. Support the searchParameters on each profile individually and in combination. 1.Support forward and reverse chaining on all search parameters that specify the 'chain' property

The NatlDir Server SHOULD:

  1. Support xml source formats for all NatlDir interactions.

Security:

  1. See the General Security Considerations section for requirements and recommendations.
  2. A server SHALL reject any unauthorized requests by returning an HTTP 401 unauthorized response code.

RESTful Capabilities by Resource/Profile:

Summary of Search Criteria

Resource TypeSupported ProfilesSupported SearchesSupported _includesSupported _revincludesSupported Operations
EndpointNatlDir Endpoint organization, _id, _lastUpdated Endpoint:organization
HealthcareServiceNatlDir HealthcareService location, coverage-area, organization, endpoint, name, service-category, service-type, specialty, _id, _lastUpdated HealthcareService:location, HealthcareService:coverage-area, HealthcareService:organization, HealthcareService:endpoint PractitionerRole:service, OrganizationAffiliation:service
InsurancePlanNatlDir InsurancePlan administered-by, owned-by, coverage-area, name, plan-type, identifier, _id, _lastUpdated, type InsurancePlan:administered-by, InsurancePlan:owned-by, InsurancePlan:coverage-area
LocationNatlDir Location partof, organization, endpoint, address-city, address-state, address-postalcode, address, type, _id, _lastUpdated Location:endpoint, Location:organization, Location:partof HealthcareService:location, InsurancePlan:coverage-area, OrganizationAffiliation:location, PractitionerRole:location
OrganizationNatlDir Network, NatlDir Organization partof, endpoint, address, name, _id, _lastUpdated, type, coverage-area Organization:partof, Organization:endpoint, Organization:coverage-area Endpoint:organization, HealthcareService:organization, InsurancePlan:administered-by, InsurancePlan:owned-by, OrganizationAffiliation:primary-organization, PractitionerRole:organization, PractitionerRole:network, OrganizationAffiliation:participating-organization
OrganizationAffiliationNatlDir OrganizationAffiliation primary-organization, participating-organization, location, service, network, endpoint, role, specialty, _id, _lastUpdated OrganizationAffiliation:primary-organization, OrganizationAffiliation:participating-organization, OrganizationAffiliation:location, OrganizationAffiliation:service, OrganizationAffiliation:endpoint, OrganizationAffiliation:network
PractitionerNatlDir Practitioner name, _id, _lastUpdated, family, given PractitionerRole:practitioner
PractitionerRoleNatlDir PractitionerRole practitioner, organization, location, service, network, endpoint, role, specialty, _id, _lastUpdated PractitionerRole:practitioner, PractitionerRole:organization, PractitionerRole:location, PractitionerRole:service, PractitionerRole:network, PractitionerRole:endpoint

Endpoint

Conformance Expectation: SHALL

Supported Profiles: NatlDir Endpoint

Reference Policy: resolves

Profile Interaction Summary:

  • SHALL support search-type, read.
  • SHOULD support vread.

Fetch and Search Criteria:

  • A Server SHALL be capable of returning a Endpoint resource using:
    GET [base]/Endpoint/[id]

  • A Server SHOULD be capable of returning a Endpoint resource using:
    GET [base]/Endpoint/[id]/_history/vid

  • A Server SHALL be capable of supporting the following _includes:
    Endpoint:organization - GET [base]/Endpoint?[parameter=value]&_include=Endpoint:organization

Search Parameter Summary:

ConformanceParameterTypeExample
SHALLorganization reference GET [base]/Endpoint?organization=[organization]
SHALL_id token GET [base]/Endpoint?_id=[id]
SHALL_lastUpdated date GET [base]/Endpoint?_lastUpdated=[_lastUpdated]

HealthcareService

Conformance Expectation: SHALL

Supported Profiles: NatlDir HealthcareService

Reference Policy: resolves

Profile Interaction Summary:

  • SHALL support search-type, read.
  • SHOULD support vread.

Fetch and Search Criteria:

  • A Server SHALL be capable of returning a HealthcareService resource using:
    GET [base]/HealthcareService/[id]

  • A Server SHOULD be capable of returning a HealthcareService resource using:
    GET [base]/HealthcareService/[id]/_history/vid

  • A Server SHALL be capable of supporting the following _includes:
    HealthcareService:location - GET [base]/HealthcareService?[parameter=value]&_include=HealthcareService:location
    HealthcareService:coverage-area - GET [base]/HealthcareService?[parameter=value]&_include=HealthcareService:coverage-area
    HealthcareService:organization - GET [base]/HealthcareService?[parameter=value]&_include=HealthcareService:organization
    HealthcareService:endpoint - GET [base]/HealthcareService?[parameter=value]&_include=HealthcareService:endpoint

  • A Server SHALL be capable of supporting the following _revincludes:
    PractitionerRole:service - GET [base]/HealthcareService?[parameter=value]&_revinclude=PractitionerRole:service
    OrganizationAffiliation:service - GET [base]/HealthcareService?[parameter=value]&_revinclude=OrganizationAffiliation:service

Search Parameter Summary:

ConformanceParameterTypeExample
SHALLlocation reference GET [base]/HealthcareService?location=[location]
SHALLcoverage-area reference GET [base]/HealthcareService?coverage-area=[coverage-area]
SHALLorganization reference GET [base]/HealthcareService?organization=[organization]
SHALLendpoint reference GET [base]/HealthcareService?endpoint=[endpoint]
SHALLname string GET [base]/HealthcareService?name=[name]
SHALLservice-category token GET [base]/HealthcareService?service-category=[system]|[code]
SHALLservice-type token GET [base]/HealthcareService?service-type=[system]|[code]
SHALLspecialty token GET [base]/HealthcareService?specialty=[system]|[code]
SHALL_id token GET [base]/HealthcareService?_id=[id]
SHALL_lastUpdated date GET [base]/HealthcareService?_lastUpdated=[_lastUpdated]

InsurancePlan

Conformance Expectation: SHALL

Supported Profiles: NatlDir InsurancePlan

Reference Policy: resolves

Profile Interaction Summary:

  • SHALL support search-type, read.
  • SHOULD support vread.

Fetch and Search Criteria:

  • A Server SHALL be capable of returning a InsurancePlan resource using:
    GET [base]/InsurancePlan/[id]

  • A Server SHOULD be capable of returning a InsurancePlan resource using:
    GET [base]/InsurancePlan/[id]/_history/vid

  • A Server SHALL be capable of supporting the following _includes:
    InsurancePlan:administered-by - GET [base]/InsurancePlan?[parameter=value]&_include=InsurancePlan:administered-by
    InsurancePlan:owned-by - GET [base]/InsurancePlan?[parameter=value]&_include=InsurancePlan:owned-by
    InsurancePlan:coverage-area - GET [base]/InsurancePlan?[parameter=value]&_include=InsurancePlan:coverage-area

Search Parameter Summary:

ConformanceParameterTypeExample
SHALLadministered-by reference GET [base]/InsurancePlan?administered-by=[administered-by]
SHALLowned-by reference GET [base]/InsurancePlan?owned-by=[owned-by]
SHALLcoverage-area reference GET [base]/InsurancePlan?coverage-area=[coverage-area]
SHALLname string GET [base]/InsurancePlan?name=[name]
SHALLplan-type token GET [base]/InsurancePlan?plan-type=[system]|[code]
SHALLidentifier token GET [base]/InsurancePlan?identifier=[system]|[code]
SHALL_id token GET [base]/InsurancePlan?_id=[id]
SHALL_lastUpdated date GET [base]/InsurancePlan?_lastUpdated=[_lastUpdated]
SHALLtype token GET [base]/InsurancePlan?type=[system]|[code]

Location

Conformance Expectation: SHALL

Supported Profiles: NatlDir Location

Reference Policy: resolves

Profile Interaction Summary:

  • SHALL support search-type, read.
  • SHOULD support vread.

Fetch and Search Criteria:

  • A Server SHALL be capable of returning a Location resource using:
    GET [base]/Location/[id]

  • A Server SHOULD be capable of returning a Location resource using:
    GET [base]/Location/[id]/_history/vid

  • A Server SHALL be capable of supporting the following _includes:
    Location:endpoint - GET [base]/Location?[parameter=value]&_include=Location:endpoint
    Location:organization - GET [base]/Location?[parameter=value]&_include=Location:organization
    Location:partof - GET [base]/Location?[parameter=value]&_include=Location:partof

  • A Server SHALL be capable of supporting the following _revincludes:
    HealthcareService:location - GET [base]/Location?[parameter=value]&_revinclude=HealthcareService:location
    InsurancePlan:coverage-area - GET [base]/Location?[parameter=value]&_revinclude=InsurancePlan:coverage-area
    OrganizationAffiliation:location - GET [base]/Location?[parameter=value]&_revinclude=OrganizationAffiliation:location
    PractitionerRole:location - GET [base]/Location?[parameter=value]&_revinclude=PractitionerRole:location

Search Parameter Summary:

ConformanceParameterTypeExample
SHALLpartof reference GET [base]/Location?partof=[partof]
SHALLorganization reference GET [base]/Location?organization=[organization]
SHALLendpoint reference GET [base]/Location?endpoint=[endpoint]
SHALLaddress-city string GET [base]/Location?address-city=[address-city]
SHALLaddress-state string GET [base]/Location?address-state=[address-state]
SHALLaddress-postalcode string GET [base]/Location?address-postalcode=[address-postalcode]
SHALLaddress string GET [base]/Location?address=[address]
SHALLtype token GET [base]/Location?type=[system]|[code]
SHALL_id token GET [base]/Location?_id=[id]
SHALL_lastUpdated date GET [base]/Location?_lastUpdated=[_lastUpdated]

Organization

Conformance Expectation: SHALL

Supported Profiles: NatlDir Network, NatlDir Organization

Reference Policy: resolves

Profile Interaction Summary:

  • SHALL support search-type, read.
  • SHOULD support vread.

Fetch and Search Criteria:

  • A Server SHALL be capable of returning a Organization resource using:
    GET [base]/Organization/[id]

  • A Server SHOULD be capable of returning a Organization resource using:
    GET [base]/Organization/[id]/_history/vid

  • A Server SHALL be capable of supporting the following _includes:
    Organization:partof - GET [base]/Organization?[parameter=value]&_include=Organization:partof
    Organization:endpoint - GET [base]/Organization?[parameter=value]&_include=Organization:endpoint
    Organization:coverage-area - GET [base]/Organization?[parameter=value]&_include=Organization:coverage-area

  • A Server SHALL be capable of supporting the following _revincludes:
    Endpoint:organization - GET [base]/Organization?[parameter=value]&_revinclude=Endpoint:organization
    HealthcareService:organization - GET [base]/Organization?[parameter=value]&_revinclude=HealthcareService:organization
    InsurancePlan:administered-by - GET [base]/Organization?[parameter=value]&_revinclude=InsurancePlan:administered-by
    InsurancePlan:owned-by - GET [base]/Organization?[parameter=value]&_revinclude=InsurancePlan:owned-by
    OrganizationAffiliation:primary-organization - GET [base]/Organization?[parameter=value]&_revinclude=OrganizationAffiliation:primary-organization
    PractitionerRole:organization - GET [base]/Organization?[parameter=value]&_revinclude=PractitionerRole:organization
    PractitionerRole:network - GET [base]/Organization?[parameter=value]&_revinclude=PractitionerRole:network
    OrganizationAffiliation:participating-organization - GET [base]/Organization?[parameter=value]&_revinclude=OrganizationAffiliation:participating-organization

Search Parameter Summary:

ConformanceParameterTypeExample
SHALLpartof reference GET [base]/Organization?partof=[partof]
SHALLendpoint reference GET [base]/Organization?endpoint=[endpoint]
SHALLaddress string GET [base]/Organization?address=[address]
SHALLname string GET [base]/Organization?name=[name]
SHALL_id token GET [base]/Organization?_id=[id]
SHALL_lastUpdated date GET [base]/Organization?_lastUpdated=[_lastUpdated]
SHALLtype token GET [base]/Organization?type=[system]|[code]
SHALLcoverage-area reference GET [base]/Organization?coverage-area=[coverage-area]

OrganizationAffiliation

Conformance Expectation: SHALL

Supported Profiles: NatlDir OrganizationAffiliation

Reference Policy: resolves

Profile Interaction Summary:

  • SHALL support search-type, read.
  • SHOULD support vread.

Fetch and Search Criteria:

  • A Server SHALL be capable of returning a OrganizationAffiliation resource using:
    GET [base]/OrganizationAffiliation/[id]

  • A Server SHOULD be capable of returning a OrganizationAffiliation resource using:
    GET [base]/OrganizationAffiliation/[id]/_history/vid

  • A Server SHALL be capable of supporting the following _includes:
    OrganizationAffiliation:primary-organization - GET [base]/OrganizationAffiliation?[parameter=value]&_include=OrganizationAffiliation:primary-organization
    OrganizationAffiliation:participating-organization - GET [base]/OrganizationAffiliation?[parameter=value]&_include=OrganizationAffiliation:participating-organization
    OrganizationAffiliation:location - GET [base]/OrganizationAffiliation?[parameter=value]&_include=OrganizationAffiliation:location
    OrganizationAffiliation:service - GET [base]/OrganizationAffiliation?[parameter=value]&_include=OrganizationAffiliation:service
    OrganizationAffiliation:endpoint - GET [base]/OrganizationAffiliation?[parameter=value]&_include=OrganizationAffiliation:endpoint
    OrganizationAffiliation:network - GET [base]/OrganizationAffiliation?[parameter=value]&_include=OrganizationAffiliation:network

Search Parameter Summary:

ConformanceParameterTypeExample
SHALLprimary-organization reference GET [base]/OrganizationAffiliation?primary-organization=[primary-organization]
SHALLparticipating-organization reference GET [base]/OrganizationAffiliation?participating-organization=[participating-organization]
SHALLlocation reference GET [base]/OrganizationAffiliation?location=[location]
SHALLservice reference GET [base]/OrganizationAffiliation?service=[service]
SHALLnetwork reference GET [base]/OrganizationAffiliation?network=[network]
SHALLendpoint reference GET [base]/OrganizationAffiliation?endpoint=[endpoint]
SHALLrole token GET [base]/OrganizationAffiliation?role=[system]|[code]
SHALLspecialty token GET [base]/OrganizationAffiliation?specialty=[system]|[code]
SHALL_id token GET [base]/OrganizationAffiliation?_id=[id]
SHALL_lastUpdated date GET [base]/OrganizationAffiliation?_lastUpdated=[_lastUpdated]

Practitioner

Conformance Expectation: SHALL

Supported Profiles: NatlDir Practitioner

Reference Policy: resolves

Profile Interaction Summary:

  • SHALL support search-type, read.
  • SHOULD support vread.

Fetch and Search Criteria:

  • A Server SHALL be capable of returning a Practitioner resource using:
    GET [base]/Practitioner/[id]

  • A Server SHOULD be capable of returning a Practitioner resource using:
    GET [base]/Practitioner/[id]/_history/vid

  • A Server SHALL be capable of supporting the following _revincludes:
    PractitionerRole:practitioner - GET [base]/Practitioner?[parameter=value]&_revinclude=PractitionerRole:practitioner

Search Parameter Summary:

ConformanceParameterTypeExample
SHALLname string GET [base]/Practitioner?name=[name]
SHALL_id token GET [base]/Practitioner?_id=[id]
SHALL_lastUpdated date GET [base]/Practitioner?_lastUpdated=[_lastUpdated]
SHALLfamily string GET [base]/Practitioner?family=[family]
SHALLgiven string GET [base]/Practitioner?given=[given]

PractitionerRole

Conformance Expectation: SHALL

Supported Profiles: NatlDir PractitionerRole

Reference Policy: resolves

Profile Interaction Summary:

  • SHALL support search-type, read.
  • SHOULD support vread.

Fetch and Search Criteria:

  • A Server SHALL be capable of returning a PractitionerRole resource using:
    GET [base]/PractitionerRole/[id]

  • A Server SHOULD be capable of returning a PractitionerRole resource using:
    GET [base]/PractitionerRole/[id]/_history/vid

  • A Server SHALL be capable of supporting the following _includes:
    PractitionerRole:practitioner - GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:practitioner
    PractitionerRole:organization - GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:organization
    PractitionerRole:location - GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:location
    PractitionerRole:service - GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:service
    PractitionerRole:network - GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:network
    PractitionerRole:endpoint - GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:endpoint

Search Parameter Summary:

ConformanceParameterTypeExample
SHALLpractitioner reference GET [base]/PractitionerRole?practitioner=[practitioner]
SHALLorganization reference GET [base]/PractitionerRole?organization=[organization]
SHALLlocation reference GET [base]/PractitionerRole?location=[location]
SHALLservice reference GET [base]/PractitionerRole?service=[service]
SHALLnetwork reference GET [base]/PractitionerRole?network=[network]
SHALLendpoint reference GET [base]/PractitionerRole?endpoint=[endpoint]
SHALLrole token GET [base]/PractitionerRole?role=[system]|[code]
SHALLspecialty token GET [base]/PractitionerRole?specialty=[system]|[code]
SHALL_id token GET [base]/PractitionerRole?_id=[id]
SHALL_lastUpdated date GET [base]/PractitionerRole?_lastUpdated=[_lastUpdated]

Source

{
  "resourceType" : "CapabilityStatement",
  "id" : "NatlDir",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2 id=\"title\">NatlDir CapabilityStatement</h2><ul><li>Implementation Guide Version: 1.0.0</li><li>FHIR Version: 4.0.1</li><li>Supported formats: xml, json</li><li>Published: 2020-11-19</li><li>Published by: HL7 Financial Management Working Group (FM WG)</li></ul><p>This Section describes the expected capabilities of the NatlDir Server actor which is responsible for providing responses to the queries submitted by the NatlDir Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by NatlDir Servers are defined. Systems implementing this capability statement should meet the CMS FInal Rule requirement for provider directory access.  NatlDir  Clients can use the required capabilities to access necessary data based on their local use cases and other contextual requirements.</p><h3 id=\"behavior\">FHIR RESTful Capabilities</h3><p>The NatlDir  Server <strong>SHALL</strong>:</p><ol><li>Support all profiles defined in this Implementation Guide..</li><li>Implement the RESTful behavior according to the FHIR specification.</li><li>Return the following response classes:\n<ul><li>(Status 400): invalid parameter</li><li>(Status 401/4xx): unauthorized request</li><li>(Status 403): insufficient scope</li><li>(Status 404): unknown resource</li><li>(Status 410): deleted resource.</li></ul>\n</li><li>Support json source formats for all NatlDir interactions.</li><li>Identify the NatlDir  profiles supported as part of the FHIR <code>meta.profile</code> attribute for each instance.</li><li>Support the searchParameters on each profile  individually and in combination.\n1.Support forward and reverse chaining on all search parameters that specify the 'chain' property</li></ol><p>The NatlDir  Server <strong>SHOULD</strong>:</p><ol><li>Support xml source formats for all NatlDir  interactions.</li></ol><p id=\"security\"><strong>Security:</strong></p><ol><li>See the <a href=\"security.html\">General Security Considerations</a> section for requirements and recommendations.</li><li>A server <strong>SHALL</strong> reject any unauthorized requests by returning an <code>HTTP 401</code> unauthorized response code.</li></ol><h3 id=\"resource--details\" class=\"no_toc\">RESTful Capabilities by Resource/Profile:</h3><p><strong>Summary of Search Criteria</strong></p><table class=\"grid\"><thead><tr><th>Resource Type</th><th>Supported Profiles</th><th>Supported Searches</th><th>Supported <code>_includes</code></th><th>Supported <code>_revincludes</code></th><th>Supported Operations</th></tr></thead><tbody><tr><td><a href=\"#endpoint\">Endpoint</a></td><td><a href=\"StructureDefinition-NatlDirAttest-Endpoint.html\">NatlDir Endpoint</a></td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\torganization, _id, _lastUpdated\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n\t\t\t\t\t\t\tEndpoint:organization\n\t\t\t\t\t\t</td><td>\n              \n            </td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td></tr><tr><td><a href=\"#healthcareservice\">HealthcareService</a></td><td><a href=\"StructureDefinition-NatlDirAttest-HealthcareService.html\">NatlDir HealthcareService</a></td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\tlocation, coverage-area, organization, endpoint, name, service-category, service-type, specialty, _id, _lastUpdated\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n\t\t\t\t\t\t\tHealthcareService:location, HealthcareService:coverage-area, HealthcareService:organization, HealthcareService:endpoint\n\t\t\t\t\t\t</td><td>\n              PractitionerRole:service, OrganizationAffiliation:service\n            </td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td></tr><tr><td><a href=\"#insuranceplan\">InsurancePlan</a></td><td><a href=\"StructureDefinition-NatlDirAttest-InsurancePlan.html\">NatlDir InsurancePlan</a></td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\tadministered-by, owned-by, coverage-area, name, plan-type, identifier, _id, _lastUpdated, type\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n\t\t\t\t\t\t\tInsurancePlan:administered-by, InsurancePlan:owned-by, InsurancePlan:coverage-area\n\t\t\t\t\t\t</td><td>\n              \n            </td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td></tr><tr><td><a href=\"#location\">Location</a></td><td><a href=\"StructureDefinition-NatlDirAttest-Location.html\">NatlDir Location</a></td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\tpartof, organization, endpoint, address-city, address-state, address-postalcode, address, type, _id, _lastUpdated\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n\t\t\t\t\t\t\tLocation:endpoint, Location:organization, Location:partof\n\t\t\t\t\t\t</td><td>\n              HealthcareService:location, InsurancePlan:coverage-area, OrganizationAffiliation:location, PractitionerRole:location\n            </td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td></tr><tr><td><a href=\"#organization\">Organization</a></td><td><a href=\"StructureDefinition-NatlDirAttest-Network.html\">NatlDir Network</a>, \n\n\t\t\t\t\t\t<a href=\"StructureDefinition-NatlDirAttest-Organization.html\">NatlDir Organization</a></td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\tpartof, endpoint, address, name, _id, _lastUpdated, type, coverage-area\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n\t\t\t\t\t\t\tOrganization:partof, Organization:endpoint, Organization:coverage-area\n\t\t\t\t\t\t</td><td>\n              Endpoint:organization, HealthcareService:organization, InsurancePlan:administered-by, InsurancePlan:owned-by, OrganizationAffiliation:primary-organization, PractitionerRole:organization, PractitionerRole:network, OrganizationAffiliation:participating-organization\n            </td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td></tr><tr><td><a href=\"#organizationaffiliation\">OrganizationAffiliation</a></td><td><a href=\"StructureDefinition-NatlDirAttest-OrganizationAffiliation.html\">NatlDir OrganizationAffiliation</a></td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\tprimary-organization, participating-organization, location, service, network, endpoint, role, specialty, _id, _lastUpdated\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n\t\t\t\t\t\t\tOrganizationAffiliation:primary-organization, OrganizationAffiliation:participating-organization, OrganizationAffiliation:location, OrganizationAffiliation:service, OrganizationAffiliation:endpoint, OrganizationAffiliation:network\n\t\t\t\t\t\t</td><td>\n              \n            </td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td></tr><tr><td><a href=\"#practitioner\">Practitioner</a></td><td><a href=\"StructureDefinition-NatlDirAttest-Practitioner.html\">NatlDir Practitioner</a></td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\tname, _id, _lastUpdated, family, given\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n              PractitionerRole:practitioner\n            </td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td></tr><tr><td><a href=\"#practitionerrole\">PractitionerRole</a></td><td><a href=\"StructureDefinition-NatlDirAttest-PractitionerRole.html\">NatlDir PractitionerRole</a></td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\tpractitioner, organization, location, service, network, endpoint, role, specialty, _id, _lastUpdated\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n\t\t\t\t\t\t\tPractitionerRole:practitioner, PractitionerRole:organization, PractitionerRole:location, PractitionerRole:service, PractitionerRole:network, PractitionerRole:endpoint\n\t\t\t\t\t\t</td><td>\n              \n            </td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td></tr></tbody></table><br/><h4 id=\"endpoint\" class=\"no_toc\">Endpoint</h4><p>Conformance Expectation:\t<strong>SHALL</strong></p><p>Supported Profiles:\n\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t<a href=\"StructureDefinition-NatlDirAttest-Endpoint.html\">NatlDir Endpoint</a>\n\t\t\t\t\n\t\t\t\t</p><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>search-type</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>read</code>.</li><li><strong>SHOULD</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>vread</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>\n\t\t\t\t\tA Server <strong>SHALL</strong> be capable of returning a Endpoint resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Endpoint/[id]</code>\n\t\t\t\t</li><br/><li>\n\t\t\t\t\tA Server <strong>SHOULD</strong> be capable of returning a Endpoint resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Endpoint/[id]/_history/vid</code>\n\t\t\t\t</li><br/>  <!-- Only SHALL for include for now the capability statement does not create the primitive\n\t\t\t\t     extensios for this yet. --><li>\n\t\t\t\t\tA Server <strong>SHALL</strong> be capable of supporting the following _includes:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\n\t\t\t\t\t\tEndpoint:organization - <code class=\"highlighter-rouge\">GET [base]/Endpoint?[parameter=value]&amp;_include=Endpoint:organization</code><br/>\n\t\t\t\t\t\n\t\t\t\t</li><br/>  <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-endpoint-organization.html\">organization</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Endpoint?organization=[organization]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">_id</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Endpoint?_id=[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">_lastUpdated</a></td><td>\n\t\t\t\t\t\t\tdate\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Endpoint?_lastUpdated=[_lastUpdated]</code></td></tr></tbody></table><hr/><h4 id=\"healthcareservice\" class=\"no_toc\">HealthcareService</h4><p>Conformance Expectation:\t<strong>SHALL</strong></p><p>Supported Profiles:\n\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t<a href=\"StructureDefinition-NatlDirAttest-HealthcareService.html\">NatlDir HealthcareService</a>\n\t\t\t\t\n\t\t\t\t</p><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>search-type</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>read</code>.</li><li><strong>SHOULD</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>vread</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>\n\t\t\t\t\tA Server <strong>SHALL</strong> be capable of returning a HealthcareService resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/HealthcareService/[id]</code>\n\t\t\t\t</li><br/><li>\n\t\t\t\t\tA Server <strong>SHOULD</strong> be capable of returning a HealthcareService resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/HealthcareService/[id]/_history/vid</code>\n\t\t\t\t</li><br/>  <!-- Only SHALL for include for now the capability statement does not create the primitive\n\t\t\t\t     extensios for this yet. --><li>\n\t\t\t\t\tA Server <strong>SHALL</strong> be capable of supporting the following _includes:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\n\t\t\t\t\t\tHealthcareService:location - <code class=\"highlighter-rouge\">GET [base]/HealthcareService?[parameter=value]&amp;_include=HealthcareService:location</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tHealthcareService:coverage-area - <code class=\"highlighter-rouge\">GET [base]/HealthcareService?[parameter=value]&amp;_include=HealthcareService:coverage-area</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tHealthcareService:organization - <code class=\"highlighter-rouge\">GET [base]/HealthcareService?[parameter=value]&amp;_include=HealthcareService:organization</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tHealthcareService:endpoint - <code class=\"highlighter-rouge\">GET [base]/HealthcareService?[parameter=value]&amp;_include=HealthcareService:endpoint</code><br/>\n\t\t\t\t\t\n\t\t\t\t</li><br/>  <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --><li>\n\t\t\t\t\tA Server <strong>SHALL</strong> be capable of supporting the following _revincludes:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\n\t\t\t\t\t\tPractitionerRole:service - <code class=\"highlighter-rouge\">GET [base]/HealthcareService?[parameter=value]&amp;_revinclude=PractitionerRole:service</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tOrganizationAffiliation:service - <code class=\"highlighter-rouge\">GET [base]/HealthcareService?[parameter=value]&amp;_revinclude=OrganizationAffiliation:service</code><br/>\n\t\t\t\t\t\n\t\t\t\t</li><br/></ul><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-healthcareservice-location.html\">location</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/HealthcareService?location=[location]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-healthcareservice-coverage-area.html\">coverage-area</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/HealthcareService?coverage-area=[coverage-area]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-healthcareservice-organization.html\">organization</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/HealthcareService?organization=[organization]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-healthcareservice-endpoint.html\">endpoint</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/HealthcareService?endpoint=[endpoint]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-healthcareservice-name.html\">name</a></td><td>\n\t\t\t\t\t\t\tstring\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/HealthcareService?name=[name]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-healthcareservice-service-category.html\">service-category</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/HealthcareService?service-category=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-healthcareservice-service-type.html\">service-type</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/HealthcareService?service-type=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-healthcareservice-specialty.html\">specialty</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/HealthcareService?specialty=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">_id</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/HealthcareService?_id=[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">_lastUpdated</a></td><td>\n\t\t\t\t\t\t\tdate\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/HealthcareService?_lastUpdated=[_lastUpdated]</code></td></tr></tbody></table><hr/><h4 id=\"insuranceplan\" class=\"no_toc\">InsurancePlan</h4><p>Conformance Expectation:\t<strong>SHALL</strong></p><p>Supported Profiles:\n\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t<a href=\"StructureDefinition-NatlDirAttest-InsurancePlan.html\">NatlDir InsurancePlan</a>\n\t\t\t\t\n\t\t\t\t</p><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>search-type</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>read</code>.</li><li><strong>SHOULD</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>vread</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>\n\t\t\t\t\tA Server <strong>SHALL</strong> be capable of returning a InsurancePlan resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/InsurancePlan/[id]</code>\n\t\t\t\t</li><br/><li>\n\t\t\t\t\tA Server <strong>SHOULD</strong> be capable of returning a InsurancePlan resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/InsurancePlan/[id]/_history/vid</code>\n\t\t\t\t</li><br/>  <!-- Only SHALL for include for now the capability statement does not create the primitive\n\t\t\t\t     extensios for this yet. --><li>\n\t\t\t\t\tA Server <strong>SHALL</strong> be capable of supporting the following _includes:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\n\t\t\t\t\t\tInsurancePlan:administered-by - <code class=\"highlighter-rouge\">GET [base]/InsurancePlan?[parameter=value]&amp;_include=InsurancePlan:administered-by</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tInsurancePlan:owned-by - <code class=\"highlighter-rouge\">GET [base]/InsurancePlan?[parameter=value]&amp;_include=InsurancePlan:owned-by</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tInsurancePlan:coverage-area - <code class=\"highlighter-rouge\">GET [base]/InsurancePlan?[parameter=value]&amp;_include=InsurancePlan:coverage-area</code><br/>\n\t\t\t\t\t\n\t\t\t\t</li><br/>  <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-insuranceplan-administered-by.html\">administered-by</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/InsurancePlan?administered-by=[administered-by]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-insuranceplan-owned-by.html\">owned-by</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/InsurancePlan?owned-by=[owned-by]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-insuranceplan-coverage-area.html\">coverage-area</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/InsurancePlan?coverage-area=[coverage-area]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-insuranceplan-name.html\">name</a></td><td>\n\t\t\t\t\t\t\tstring\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/InsurancePlan?name=[name]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-insuranceplan-plan-type.html\">plan-type</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/InsurancePlan?plan-type=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-insuranceplan-identifier.html\">identifier</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/InsurancePlan?identifier=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">_id</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/InsurancePlan?_id=[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">_lastUpdated</a></td><td>\n\t\t\t\t\t\t\tdate\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/InsurancePlan?_lastUpdated=[_lastUpdated]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-insuranceplan-type.html\">type</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/InsurancePlan?type=[system]|[code]</code></td></tr></tbody></table><hr/><h4 id=\"location\" class=\"no_toc\">Location</h4><p>Conformance Expectation:\t<strong>SHALL</strong></p><p>Supported Profiles:\n\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t<a href=\"StructureDefinition-NatlDirAttest-Location.html\">NatlDir Location</a>\n\t\t\t\t\n\t\t\t\t</p><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>search-type</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>read</code>.</li><li><strong>SHOULD</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>vread</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>\n\t\t\t\t\tA Server <strong>SHALL</strong> be capable of returning a Location resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Location/[id]</code>\n\t\t\t\t</li><br/><li>\n\t\t\t\t\tA Server <strong>SHOULD</strong> be capable of returning a Location resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Location/[id]/_history/vid</code>\n\t\t\t\t</li><br/>  <!-- Only SHALL for include for now the capability statement does not create the primitive\n\t\t\t\t     extensios for this yet. --><li>\n\t\t\t\t\tA Server <strong>SHALL</strong> be capable of supporting the following _includes:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\n\t\t\t\t\t\tLocation:endpoint - <code class=\"highlighter-rouge\">GET [base]/Location?[parameter=value]&amp;_include=Location:endpoint</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tLocation:organization - <code class=\"highlighter-rouge\">GET [base]/Location?[parameter=value]&amp;_include=Location:organization</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tLocation:partof - <code class=\"highlighter-rouge\">GET [base]/Location?[parameter=value]&amp;_include=Location:partof</code><br/>\n\t\t\t\t\t\n\t\t\t\t</li><br/>  <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --><li>\n\t\t\t\t\tA Server <strong>SHALL</strong> be capable of supporting the following _revincludes:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\n\t\t\t\t\t\tHealthcareService:location - <code class=\"highlighter-rouge\">GET [base]/Location?[parameter=value]&amp;_revinclude=HealthcareService:location</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tInsurancePlan:coverage-area - <code class=\"highlighter-rouge\">GET [base]/Location?[parameter=value]&amp;_revinclude=InsurancePlan:coverage-area</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tOrganizationAffiliation:location - <code class=\"highlighter-rouge\">GET [base]/Location?[parameter=value]&amp;_revinclude=OrganizationAffiliation:location</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tPractitionerRole:location - <code class=\"highlighter-rouge\">GET [base]/Location?[parameter=value]&amp;_revinclude=PractitionerRole:location</code><br/>\n\t\t\t\t\t\n\t\t\t\t</li><br/></ul><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-location-partof.html\">partof</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Location?partof=[partof]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-location-organization.html\">organization</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Location?organization=[organization]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-location-endpoint.html\">endpoint</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Location?endpoint=[endpoint]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-location-address-city.html\">address-city</a></td><td>\n\t\t\t\t\t\t\tstring\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Location?address-city=[address-city]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-location-address-state.html\">address-state</a></td><td>\n\t\t\t\t\t\t\tstring\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Location?address-state=[address-state]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-location-address-postalcode.html\">address-postalcode</a></td><td>\n\t\t\t\t\t\t\tstring\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Location?address-postalcode=[address-postalcode]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-location-address.html\">address</a></td><td>\n\t\t\t\t\t\t\tstring\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Location?address=[address]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-location-type.html\">type</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Location?type=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">_id</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Location?_id=[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">_lastUpdated</a></td><td>\n\t\t\t\t\t\t\tdate\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Location?_lastUpdated=[_lastUpdated]</code></td></tr></tbody></table><hr/><h4 id=\"organization\" class=\"no_toc\">Organization</h4><p>Conformance Expectation:\t<strong>SHALL</strong></p><p>Supported Profiles:\n\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t<a href=\"StructureDefinition-NatlDirAttest-Network.html\">NatlDir Network</a>, \n\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t<a href=\"StructureDefinition-NatlDirAttest-Organization.html\">NatlDir Organization</a>\n\t\t\t\t\n\t\t\t\t</p><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>search-type</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>read</code>.</li><li><strong>SHOULD</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>vread</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>\n\t\t\t\t\tA Server <strong>SHALL</strong> be capable of returning a Organization resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Organization/[id]</code>\n\t\t\t\t</li><br/><li>\n\t\t\t\t\tA Server <strong>SHOULD</strong> be capable of returning a Organization resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Organization/[id]/_history/vid</code>\n\t\t\t\t</li><br/>  <!-- Only SHALL for include for now the capability statement does not create the primitive\n\t\t\t\t     extensios for this yet. --><li>\n\t\t\t\t\tA Server <strong>SHALL</strong> be capable of supporting the following _includes:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\n\t\t\t\t\t\tOrganization:partof - <code class=\"highlighter-rouge\">GET [base]/Organization?[parameter=value]&amp;_include=Organization:partof</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tOrganization:endpoint - <code class=\"highlighter-rouge\">GET [base]/Organization?[parameter=value]&amp;_include=Organization:endpoint</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tOrganization:coverage-area - <code class=\"highlighter-rouge\">GET [base]/Organization?[parameter=value]&amp;_include=Organization:coverage-area</code><br/>\n\t\t\t\t\t\n\t\t\t\t</li><br/>  <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --><li>\n\t\t\t\t\tA Server <strong>SHALL</strong> be capable of supporting the following _revincludes:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\n\t\t\t\t\t\tEndpoint:organization - <code class=\"highlighter-rouge\">GET [base]/Organization?[parameter=value]&amp;_revinclude=Endpoint:organization</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tHealthcareService:organization - <code class=\"highlighter-rouge\">GET [base]/Organization?[parameter=value]&amp;_revinclude=HealthcareService:organization</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tInsurancePlan:administered-by - <code class=\"highlighter-rouge\">GET [base]/Organization?[parameter=value]&amp;_revinclude=InsurancePlan:administered-by</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tInsurancePlan:owned-by - <code class=\"highlighter-rouge\">GET [base]/Organization?[parameter=value]&amp;_revinclude=InsurancePlan:owned-by</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tOrganizationAffiliation:primary-organization - <code class=\"highlighter-rouge\">GET [base]/Organization?[parameter=value]&amp;_revinclude=OrganizationAffiliation:primary-organization</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tPractitionerRole:organization - <code class=\"highlighter-rouge\">GET [base]/Organization?[parameter=value]&amp;_revinclude=PractitionerRole:organization</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tPractitionerRole:network - <code class=\"highlighter-rouge\">GET [base]/Organization?[parameter=value]&amp;_revinclude=PractitionerRole:network</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tOrganizationAffiliation:participating-organization - <code class=\"highlighter-rouge\">GET [base]/Organization?[parameter=value]&amp;_revinclude=OrganizationAffiliation:participating-organization</code><br/>\n\t\t\t\t\t\n\t\t\t\t</li><br/></ul><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-organization-partof.html\">partof</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Organization?partof=[partof]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-organization-endpoint.html\">endpoint</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Organization?endpoint=[endpoint]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-organization-address.html\">address</a></td><td>\n\t\t\t\t\t\t\tstring\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Organization?address=[address]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-organization-name.html\">name</a></td><td>\n\t\t\t\t\t\t\tstring\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Organization?name=[name]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">_id</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Organization?_id=[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">_lastUpdated</a></td><td>\n\t\t\t\t\t\t\tdate\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Organization?_lastUpdated=[_lastUpdated]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-organization-type.html\">type</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Organization?type=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-organization-coverage-area.html\">coverage-area</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Organization?coverage-area=[coverage-area]</code></td></tr></tbody></table><hr/><h4 id=\"organizationaffiliation\" class=\"no_toc\">OrganizationAffiliation</h4><p>Conformance Expectation:\t<strong>SHALL</strong></p><p>Supported Profiles:\n\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t<a href=\"StructureDefinition-NatlDirAttest-OrganizationAffiliation.html\">NatlDir OrganizationAffiliation</a>\n\t\t\t\t\n\t\t\t\t</p><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>search-type</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>read</code>.</li><li><strong>SHOULD</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>vread</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>\n\t\t\t\t\tA Server <strong>SHALL</strong> be capable of returning a OrganizationAffiliation resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/OrganizationAffiliation/[id]</code>\n\t\t\t\t</li><br/><li>\n\t\t\t\t\tA Server <strong>SHOULD</strong> be capable of returning a OrganizationAffiliation resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/OrganizationAffiliation/[id]/_history/vid</code>\n\t\t\t\t</li><br/>  <!-- Only SHALL for include for now the capability statement does not create the primitive\n\t\t\t\t     extensios for this yet. --><li>\n\t\t\t\t\tA Server <strong>SHALL</strong> be capable of supporting the following _includes:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\n\t\t\t\t\t\tOrganizationAffiliation:primary-organization - <code class=\"highlighter-rouge\">GET [base]/OrganizationAffiliation?[parameter=value]&amp;_include=OrganizationAffiliation:primary-organization</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tOrganizationAffiliation:participating-organization - <code class=\"highlighter-rouge\">GET [base]/OrganizationAffiliation?[parameter=value]&amp;_include=OrganizationAffiliation:participating-organization</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tOrganizationAffiliation:location - <code class=\"highlighter-rouge\">GET [base]/OrganizationAffiliation?[parameter=value]&amp;_include=OrganizationAffiliation:location</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tOrganizationAffiliation:service - <code class=\"highlighter-rouge\">GET [base]/OrganizationAffiliation?[parameter=value]&amp;_include=OrganizationAffiliation:service</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tOrganizationAffiliation:endpoint - <code class=\"highlighter-rouge\">GET [base]/OrganizationAffiliation?[parameter=value]&amp;_include=OrganizationAffiliation:endpoint</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tOrganizationAffiliation:network - <code class=\"highlighter-rouge\">GET [base]/OrganizationAffiliation?[parameter=value]&amp;_include=OrganizationAffiliation:network</code><br/>\n\t\t\t\t\t\n\t\t\t\t</li><br/>  <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-organizationaffiliation-primary-organization.html\">primary-organization</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/OrganizationAffiliation?primary-organization=[primary-organization]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-organizationaffiliation-participating-organization.html\">participating-organization</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/OrganizationAffiliation?participating-organization=[participating-organization]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-organizationaffiliation-location.html\">location</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/OrganizationAffiliation?location=[location]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-organizationaffiliation-service.html\">service</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/OrganizationAffiliation?service=[service]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-organizationaffiliation-network.html\">network</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/OrganizationAffiliation?network=[network]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-organizationaffiliation-endpoint.html\">endpoint</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/OrganizationAffiliation?endpoint=[endpoint]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-organizationaffiliation-role.html\">role</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/OrganizationAffiliation?role=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-organizationaffiliation-specialty.html\">specialty</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/OrganizationAffiliation?specialty=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">_id</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/OrganizationAffiliation?_id=[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">_lastUpdated</a></td><td>\n\t\t\t\t\t\t\tdate\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/OrganizationAffiliation?_lastUpdated=[_lastUpdated]</code></td></tr></tbody></table><hr/><h4 id=\"practitioner\" class=\"no_toc\">Practitioner</h4><p>Conformance Expectation:\t<strong>SHALL</strong></p><p>Supported Profiles:\n\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t<a href=\"StructureDefinition-NatlDirAttest-Practitioner.html\">NatlDir Practitioner</a>\n\t\t\t\t\n\t\t\t\t</p><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>search-type</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>read</code>.</li><li><strong>SHOULD</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>vread</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>\n\t\t\t\t\tA Server <strong>SHALL</strong> be capable of returning a Practitioner resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Practitioner/[id]</code>\n\t\t\t\t</li><br/><li>\n\t\t\t\t\tA Server <strong>SHOULD</strong> be capable of returning a Practitioner resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Practitioner/[id]/_history/vid</code>\n\t\t\t\t</li><br/>  <!-- Only SHALL for include for now the capability statement does not create the primitive\n\t\t\t\t     extensios for this yet. -->  <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --><li>\n\t\t\t\t\tA Server <strong>SHALL</strong> be capable of supporting the following _revincludes:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\n\t\t\t\t\t\tPractitionerRole:practitioner - <code class=\"highlighter-rouge\">GET [base]/Practitioner?[parameter=value]&amp;_revinclude=PractitionerRole:practitioner</code><br/>\n\t\t\t\t\t\n\t\t\t\t</li><br/></ul><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-practitioner-name.html\">name</a></td><td>\n\t\t\t\t\t\t\tstring\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Practitioner?name=[name]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">_id</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Practitioner?_id=[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">_lastUpdated</a></td><td>\n\t\t\t\t\t\t\tdate\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Practitioner?_lastUpdated=[_lastUpdated]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-practitioner-family-name.html\">family</a></td><td>\n\t\t\t\t\t\t\tstring\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Practitioner?family=[family]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-practitioner-given-name.html\">given</a></td><td>\n\t\t\t\t\t\t\tstring\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Practitioner?given=[given]</code></td></tr></tbody></table><hr/><h4 id=\"practitionerrole\" class=\"no_toc\">PractitionerRole</h4><p>Conformance Expectation:\t<strong>SHALL</strong></p><p>Supported Profiles:\n\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t<a href=\"StructureDefinition-NatlDirAttest-PractitionerRole.html\">NatlDir PractitionerRole</a>\n\t\t\t\t\n\t\t\t\t</p><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>search-type</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>read</code>.</li><li><strong>SHOULD</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>vread</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>\n\t\t\t\t\tA Server <strong>SHALL</strong> be capable of returning a PractitionerRole resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/PractitionerRole/[id]</code>\n\t\t\t\t</li><br/><li>\n\t\t\t\t\tA Server <strong>SHOULD</strong> be capable of returning a PractitionerRole resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/PractitionerRole/[id]/_history/vid</code>\n\t\t\t\t</li><br/>  <!-- Only SHALL for include for now the capability statement does not create the primitive\n\t\t\t\t     extensios for this yet. --><li>\n\t\t\t\t\tA Server <strong>SHALL</strong> be capable of supporting the following _includes:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\n\t\t\t\t\t\tPractitionerRole:practitioner - <code class=\"highlighter-rouge\">GET [base]/PractitionerRole?[parameter=value]&amp;_include=PractitionerRole:practitioner</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tPractitionerRole:organization - <code class=\"highlighter-rouge\">GET [base]/PractitionerRole?[parameter=value]&amp;_include=PractitionerRole:organization</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tPractitionerRole:location - <code class=\"highlighter-rouge\">GET [base]/PractitionerRole?[parameter=value]&amp;_include=PractitionerRole:location</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tPractitionerRole:service - <code class=\"highlighter-rouge\">GET [base]/PractitionerRole?[parameter=value]&amp;_include=PractitionerRole:service</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tPractitionerRole:network - <code class=\"highlighter-rouge\">GET [base]/PractitionerRole?[parameter=value]&amp;_include=PractitionerRole:network</code><br/>\n\t\t\t\t\t\n\t\t\t\t\t\tPractitionerRole:endpoint - <code class=\"highlighter-rouge\">GET [base]/PractitionerRole?[parameter=value]&amp;_include=PractitionerRole:endpoint</code><br/>\n\t\t\t\t\t\n\t\t\t\t</li><br/>  <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-practitionerrole-practitioner.html\">practitioner</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/PractitionerRole?practitioner=[practitioner]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-practitionerrole-organization.html\">organization</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/PractitionerRole?organization=[organization]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-practitionerrole-location.html\">location</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/PractitionerRole?location=[location]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-practitionerrole-service.html\">service</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/PractitionerRole?service=[service]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-practitionerrole-network.html\">network</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/PractitionerRole?network=[network]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-practitionerrole-endpoint.html\">endpoint</a></td><td>\n\t\t\t\t\t\t\treference\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/PractitionerRole?endpoint=[endpoint]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-practitionerrole-role.html\">role</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/PractitionerRole?role=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"SearchParameter-practitionerrole-specialty.html\">specialty</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/PractitionerRole?specialty=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">_id</a></td><td>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/PractitionerRole?_id=[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html\">_lastUpdated</a></td><td>\n\t\t\t\t\t\t\tdate\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/PractitionerRole?_lastUpdated=[_lastUpdated]</code></td></tr></tbody></table><hr/><br/></div>"
  },
  "url" : "http://hl7.org/fhir/us/directory-attestation/CapabilityStatement/NatlDir",
  "version" : "1.0.0-ballot",
  "name" : "DavinciPdexNatlDirCapabilityStatement",
  "title" : "NatlDir CapabilityStatement",
  "status" : "active",
  "experimental" : false,
  "date" : "2020-11-19",
  "publisher" : "HL7 Patient Administration Working Group",
  "contact" : [
    {
      "name" : "HL7 Patient Administration Working Group",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.hl7.org/Special/committees/pafm"
        },
        {
          "system" : "email",
          "value" : "pafm@lists.HL7.org"
        }
      ]
    }
  ],
  "description" : "This Section describes the expected capabilities of the NatlDir Server actor which is responsible for providing responses to the queries submitted by the NatlDir Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by NatlDir Servers are defined. Systems implementing this capability statement should meet the CMS FInal Rule requirement for provider directory access.  NatlDir  Clients can use the required capabilities to access necessary data based on their local use cases and other contextual requirements.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "kind" : "requirements",
  "fhirVersion" : "4.0.1",
  "format" : [
    "xml",
    "json"
  ],
  "patchFormat" : [
    "application/json-patch+json"
  ],
  "implementationGuide" : [
    "http://http://hl7.org/fhir/us/directory-attestation/ImplementationGuide/http://hl7.org/fhir/us/directory-attestation"
  ],
  "rest" : [
    {
      "mode" : "server",
      "documentation" : "The NatlDir  Server **SHALL**:\n\n1. Support all profiles defined in this Implementation Guide..\n1.  Implement the RESTful behavior according to the FHIR specification.\n1. Return the following response classes:\n   - (Status 400): invalid parameter\n   - (Status 401/4xx): unauthorized request\n   - (Status 403): insufficient scope\n   - (Status 404): unknown resource\n   - (Status 410): deleted resource.\n1. Support json source formats for all NatlDir interactions.\n1. Identify the NatlDir  profiles supported as part of the FHIR `meta.profile` attribute for each instance.\n1. Support the searchParameters on each profile  individually and in combination.\n1.Support forward and reverse chaining on all search parameters that specify the 'chain' property\n\nThe NatlDir  Server **SHOULD**:\n\n1. Support xml source formats for all NatlDir  interactions.\n",
      "security" : {
        "description" : "1. See the [General Security Considerations](security.html) section for requirements and recommendations.\n1. A server **SHALL** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code."
      },
      "resource" : [
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            }
          ],
          "type" : "Endpoint",
          "supportedProfile" : [
            "http://hl7.org/fhir/us/directory-attestation/StructureDefinition/NatlDirAttest-Endpoint"
          ],
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "vread"
            }
          ],
          "referencePolicy" : [
            "resolves"
          ],
          "searchInclude" : [
            "Endpoint:organization"
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "organization",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/endpoint-organization",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_id",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_lastUpdated",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
              "type" : "date"
            }
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            }
          ],
          "type" : "HealthcareService",
          "supportedProfile" : [
            "http://hl7.org/fhir/us/directory-attestation/StructureDefinition/NatlDirAttest-HealthcareService"
          ],
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "vread"
            }
          ],
          "referencePolicy" : [
            "resolves"
          ],
          "searchInclude" : [
            "HealthcareService:location",
            "HealthcareService:coverage-area",
            "HealthcareService:organization",
            "HealthcareService:endpoint"
          ],
          "searchRevInclude" : [
            "PractitionerRole:service",
            "OrganizationAffiliation:service"
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "location",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/healthcareservice-location",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "coverage-area",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/healthcareservice-coverage-area",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "organization",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/healthcareservice-organization",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "endpoint",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/healthcareservice-endpoint",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "name",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/healthcareservice-name",
              "type" : "string"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "service-category",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/healthcareservice-service-category",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "service-type",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/healthcareservice-service-type",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "specialty",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/healthcareservice-specialty",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_id",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_lastUpdated",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
              "type" : "date"
            }
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            }
          ],
          "type" : "InsurancePlan",
          "supportedProfile" : [
            "http://hl7.org/fhir/us/directory-attestation/StructureDefinition/NatlDirAttest-InsurancePlan"
          ],
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "vread"
            }
          ],
          "referencePolicy" : [
            "resolves"
          ],
          "searchInclude" : [
            "InsurancePlan:administered-by",
            "InsurancePlan:owned-by",
            "InsurancePlan:coverage-area"
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "administered-by",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/insuranceplan-administered-by",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "owned-by",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/insuranceplan-owned-by",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "coverage-area",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/insuranceplan-coverage-area",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "name",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/insuranceplan-name",
              "type" : "string"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "plan-type",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/insuranceplan-plan-type",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "identifier",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/insuranceplan-identifier",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_id",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_lastUpdated",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
              "type" : "date"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "type",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/insuranceplan-type",
              "type" : "token"
            }
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            }
          ],
          "type" : "Location",
          "supportedProfile" : [
            "http://hl7.org/fhir/us/directory-attestation/StructureDefinition/NatlDirAttest-Location"
          ],
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "vread"
            }
          ],
          "referencePolicy" : [
            "resolves"
          ],
          "searchInclude" : [
            "Location:endpoint",
            "Location:organization",
            "Location:partof"
          ],
          "searchRevInclude" : [
            "HealthcareService:location",
            "InsurancePlan:coverage-area",
            "OrganizationAffiliation:location",
            "PractitionerRole:location"
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "partof",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/location-partof",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "organization",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/location-organization",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "endpoint",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/location-endpoint",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "address-city",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/location-address-city",
              "type" : "string"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "address-state",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/location-address-state",
              "type" : "string"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "address-postalcode",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/location-address-postalcode",
              "type" : "string"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "address",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/location-address",
              "type" : "string"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "type",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/location-type",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_id",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_lastUpdated",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
              "type" : "date"
            }
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            }
          ],
          "type" : "Organization",
          "supportedProfile" : [
            "http://hl7.org/fhir/us/directory-attestation/StructureDefinition/NatlDirAttest-Network",
            "http://hl7.org/fhir/us/directory-attestation/StructureDefinition/NatlDirAttest-Organization"
          ],
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "vread"
            }
          ],
          "referencePolicy" : [
            "resolves"
          ],
          "searchInclude" : [
            "Organization:partof",
            "Organization:endpoint",
            "Organization:coverage-area"
          ],
          "searchRevInclude" : [
            "Endpoint:organization",
            "HealthcareService:organization",
            "InsurancePlan:administered-by",
            "InsurancePlan:owned-by",
            "OrganizationAffiliation:primary-organization",
            "PractitionerRole:organization",
            "PractitionerRole:network",
            "OrganizationAffiliation:participating-organization"
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "partof",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/organization-partof",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "endpoint",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/organization-endpoint",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "address",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/organization-address",
              "type" : "string"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "name",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/organization-name",
              "type" : "string"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_id",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_lastUpdated",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
              "type" : "date"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "type",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/organization-type",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "coverage-area",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/organization-coverage-area",
              "type" : "reference"
            }
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            }
          ],
          "type" : "OrganizationAffiliation",
          "supportedProfile" : [
            "http://hl7.org/fhir/us/directory-attestation/StructureDefinition/NatlDirAttest-OrganizationAffiliation"
          ],
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "vread"
            }
          ],
          "referencePolicy" : [
            "resolves"
          ],
          "searchInclude" : [
            "OrganizationAffiliation:primary-organization",
            "OrganizationAffiliation:participating-organization",
            "OrganizationAffiliation:location",
            "OrganizationAffiliation:service",
            "OrganizationAffiliation:endpoint",
            "OrganizationAffiliation:network"
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "primary-organization",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/organizationaffiliation-primary-organization",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "participating-organization",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/organizationaffiliation-participating-organization",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "location",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/organizationaffiliation-location",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "service",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/organizationaffiliation-service",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "network",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/organizationaffiliation-network",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "endpoint",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/organizationaffiliation-endpoint",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "role",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/organizationaffiliation-role",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "specialty",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/organizationaffiliation-specialty",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_id",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_lastUpdated",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
              "type" : "date"
            }
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            }
          ],
          "type" : "Practitioner",
          "supportedProfile" : [
            "http://hl7.org/fhir/us/directory-attestation/StructureDefinition/NatlDirAttest-Practitioner"
          ],
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "vread"
            }
          ],
          "referencePolicy" : [
            "resolves"
          ],
          "searchRevInclude" : [
            "PractitionerRole:practitioner"
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "name",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/practitioner-name",
              "type" : "string"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_id",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_lastUpdated",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
              "type" : "date"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "family",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/practitioner-family-name",
              "type" : "string"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "given",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/practitioner-given-name",
              "type" : "string"
            }
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            }
          ],
          "type" : "PractitionerRole",
          "supportedProfile" : [
            "http://hl7.org/fhir/us/directory-attestation/StructureDefinition/NatlDirAttest-PractitionerRole"
          ],
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "vread"
            }
          ],
          "referencePolicy" : [
            "resolves"
          ],
          "searchInclude" : [
            "PractitionerRole:practitioner",
            "PractitionerRole:organization",
            "PractitionerRole:location",
            "PractitionerRole:service",
            "PractitionerRole:network",
            "PractitionerRole:endpoint"
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "practitioner",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/practitionerrole-practitioner",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "organization",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/practitionerrole-organization",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "location",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/practitionerrole-location",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "service",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/practitionerrole-service",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "network",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/practitionerrole-network",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "endpoint",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/practitionerrole-endpoint",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "role",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/practitionerrole-role",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "specialty",
              "definition" : "http://hl7.org/fhir/us/directory-attestation/SearchParameter/practitionerrole-specialty",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_id",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_lastUpdated",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
              "type" : "date"
            }
          ]
        }
      ]
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.